/**********************************************************************
 *** *                                                            * ***
 *** *  Copyright (c) 2013 Harmonia Holdings Group LLC            * ***
 *** *                                                            * ***
 *** * Permission is hereby granted to use, modify, copy, and     * ***
 *** * distribute this software and its documentation for any     * ***
 *** * purpose only without profit, provided that the above       * ***
 *** * Copyright Notice appears in all copies and that both the   * ***
 *** * Copyright Notice and this Permission Notice appears in     * ***
 *** * every copy of supporting documentation.  No title to nor   * ***
 *** * ownership of the software is transferred hereby.  The name * ***
 *** * of Harmonia Holdings Group LLC shall not be used in        * ***
 *** * advertising or publicity related to the distribution of    * ***
 *** * the software without specific, written, prior permission.  * ***
 *** * This software is provided as-delivered without expressed   * ***
 *** * or implied warranty.  Harmonia Holdings Group LLC          * ***
 *** * makes no representation about the suitability of this      * ***
 *** * software for any purpose and accepts no responsibility for * ***
 *** * its use.                                                   * ***
 *** *                                                            * ***
 *** ************************************************************** ***
 *** *                                                            * ***
 *** * This program is free software; you can redistribute it     * ***
 *** * and/or modify it under the terms of the GNU General Public * ***
 *** * License as published by the Free Software Foundation;      * ***
 *** * either version 2 of the License, or (at your option) any   * ***
 *** * later version.                                             * ***
 *** *                                                            * ***
 *** * This program is distributed in the hope that it will be    * ***
 *** * useful, but WITHOUT ANY WARRANTY; without even the implied * ***
 *** * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR    * ***
 *** * PURPOSE.  See the GNU General Public License for more      * ***
 *** * details.                                                   * ***
 *** *                                                            * ***
 *** * You should have received a copy of the GNU General Public  * ***
 *** * License along with this program; if not, write to the Free * ***
 *** * Software Foundation, Inc., 51 Franklin Street, Fifth       * ***
 *** * Floor, Boston, MA 02110-1301, USA.                         * ***
 *** *                                                            * ***
 *** * For more information: http://www.gnu.org/licenses/gpl.html * ***
 *** *                                                            * ***
 **********************************************************************/
package org.etexascode.interrep.datamodel;

import java.io.Serializable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;

/**
 * Messaging class for passing the project's metadata from the etexas simulation up to the webapp.
 * 
 * @author ablatt
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
public class SimMetaData implements Serializable {
	/** Serial ID. */
	@XmlTransient
	private static final long serialVersionUID = 8702631056101998190L;
	
	/**
	 * The width of the simulation in centimeters.
	 */
	@XmlElement
	double simWidth;
	/**
	 * The height of the simulation in centimeters.
	 */
	@XmlElement
	double simHeight;
	/**
	 * The total amount of time steps this simulation will take.
	 */
	@XmlElement
	long maxSteps;
	/**
	 * The first step in the simulation. 
	 */
	@XmlElement
	long firstStep = 0;
	/**
	 * The number of seconds per simulated step.
	 */
	@XmlElement
	double stepSize;


	/**
	 * Get the simulation's width
	 * @return The simulation's width
	 */
	public double getSimWidth() {
		return simWidth;
	}

	/**
	 * Set the simulation's width
	 * @param simWidth
	 */
	public void setSimWidth(double simWidth) {
		this.simWidth = simWidth;
	}

	/**
	 * Get the simulation's height
	 * @return The simulation's height
	 */
	public double getSimHeight() {
		return simHeight;
	}

	/**
	 * Set the simulation's height
	 * @param simHeight
	 */
	public void setSimHeight(double simHeight) {
		this.simHeight = simHeight;
	}

	/**
	 * Get the total number of steps in the simulation. 
	 * 
	 * @return The total number of steps in the simulation. 
	 */
	public long getMaxSteps() {
		return maxSteps;
	}

	/**
	 * Set the total number of steps in the simulation. 
	 * 
	 * @param maxSteps The total number of steps in the simulation. 
	 */
	public void setMaxSteps(long maxSteps) {
		this.maxSteps = maxSteps;
	}

	/**
	 * Get the step size of the simulation in seconds
	 * @return The step size of the simulation in seconds
	 */
	public double getStepSize() {
		return stepSize;
	}

	/**
	 * Set the step size of the simulation in seconds
	 * @param stepSize
	 */
	public void setStepSize(double stepSize) {
		this.stepSize = stepSize;
	}

	/**
	 * Gets the first step of the simulation.
	 * @return The first step.
	 */
	public long getFirstStep() {
		return firstStep;
	}

	/**
	 * Sets the first step of the simulation.
	 * @param firstStep
	 */
	public void setFirstStep(long firstStep) {
		this.firstStep = firstStep;
	}
}